Skip to content

feat(TabItem): add ErrorLogger support on TabItem #6143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jun 3, 2025
Merged

feat(TabItem): add ErrorLogger support on TabItem #6143

merged 4 commits into from
Jun 3, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 3, 2025 •
edited by sourcery-ai bot
Loading

Link issues

fixes #6142

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Enable configurable error logging on Tab and TabItem components by exposing new parameters and embedding the ErrorLogger component around tab content, while refactoring cascading parameters and sourcing defaults from global options.

New Features:

  • Introduce per-tab error logging by adding EnableErrorLogger, ShowErrorLoggerToast, and ErrorLoggerToastTitle parameters to the Tab component
  • Wrap each TabItemContent in an ErrorLogger to capture and display errors within tab panes

Enhancements:

  • Refactor TabItemContent to cascade the Tab parent instead of Layout for cleaner configuration propagation
  • Use IOptionsMonitor in Layout to derive default error logger settings when parameters are unset

@bb-auto bb-auto bot added the enhancement New feature or request label Jun 3, 2025
@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 3, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 3, 2025 •
edited
Loading

Reviewer's Guide

This PR integrates the ErrorLogger component into TabItem by extending the Tab component with configurable logger parameters, refactoring TabItemContent to wrap its content in ErrorLogger using those settings, and updating the Layout component to source defaults from configuration and forward them to both ErrorLogger and Tab.

Updated Class Diagram: ErrorLogger Integration Components

classDiagram
    class Layout {
        +IOptionsMonitor_BootstrapBlazorOptions_ Options (new)
        -_enableErrorLogger: bool (new)
        -_showToast: bool (new)
    }
    class Tab {
        +bool? EnableErrorLogger (new)
        +bool? ShowErrorLoggerToast (new)
        +string? ErrorLoggerToastTitle (new)
    }
    class TabItemContent {
        -Layout? Layout (removed CascadingParameter)
        +Tab TabSet (new CascadingParameter)
        +RenderItemContent() (updated to use TabSet)
    }
    class BootstrapBlazorOptions {
        +bool EnableErrorLogger
        +bool ShowErrorLoggerToast
    }
    class ErrorLogger {
        +RenderFragment ChildContent
        +bool? EnableErrorLogger
        +bool? ShowToast
        +string? ToastTitle
    }

    Layout ..> BootstrapBlazorOptions : Reads defaults for own ErrorLogger
    Layout ..> Tab : Passes settings to
    TabItemContent ..> Tab : Accesses TabSet for ErrorLogger settings
    TabItemContent ..> ErrorLogger : Instantiates & Configures
Loading

File-Level Changes

Change Details Files
Introduce configurable ErrorLogger parameters on Tab component
  • Add nullable bool parameter EnableErrorLogger
  • Add nullable bool parameter ShowErrorLoggerToast
  • Add string parameter ErrorLoggerToastTitle
 src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Refactor TabItemContent to wrap content in ErrorLogger with Tab-level settings
  • Change cascading parameter from Layout to TabSet
  • Use TabSet.EnableErrorLogger and TabSet.ShowErrorLoggerToast
  • Add TabSet.ErrorLoggerToastTitle to ErrorLogger.ToastTitle
 src/BootstrapBlazor/Components/Tab/TabItemContent.cs
Update Layout to source defaults from config and propagate logger settings
  • Inject IOptionsMonitor
  • Compute private _enableErrorLogger and _showToast from parameters or options
  • Update Razor markup to use computed fields and pass logger parameters to ErrorLogger and nested Tab
 src/BootstrapBlazor/Components/Layout/Layout.razor.cs
src/BootstrapBlazor/Components/Layout/Layout.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6142 Add ErrorLogger support to the TabItem component. ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ArgoZhang ArgoZhang merged commit 5acba45 into main Jun 3, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the refactor-tabitem branch June 3, 2025 09:32
@codecov
Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b63ed8a) to head (03613cc).
Report is 2 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #6143   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          703       703           
  Lines        31084     31088    +4     
  Branches      4397      4395    -2     
=========================================
+ Hits         31084     31088    +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sourcery-ai[bot]
sourcery-ai bot approved these changes Jun 3, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.7.0

Development

Successfully merging this pull request may close these issues.

feat(TabItem): add ErrorLogger support on TabItem

2 participants

@ArgoZhang